Package com.stytch.sdk

Types

Link copied to clipboard
sealed class AuthenticationFactor
Link copied to clipboard
typealias AuthResponse = StytchResult<AuthData>

Type alias for StytchResult used for authentication responses

Link copied to clipboard
typealias BaseResponse = StytchResult<BasicData>

Type alias for StytchResult used for basic responses

Link copied to clipboard
enum BiometricAvailability : Enum<BiometricAvailability>
Link copied to clipboard
interface Biometrics

Biometrics interface that encompasses registration and authentication functions

Link copied to clipboard
typealias BiometricsAuthResponse = StytchResult<BiometricsAuthData>

Type alias for StytchResult used for Biometrics authentication responses

Link copied to clipboard
class BiometricsImpl : Biometrics
Link copied to clipboard
typealias DeleteFactorResponse = StytchResult<DeleteAuthenticationFactorData>

Type alias for StytchResult used for deleting authentication factors from a user

Link copied to clipboard
typealias LoginOrCreateOTPResponse = StytchResult<LoginOrCreateOTPData>

Type alias for StytchResult used for loginOrCreateOTP responses

Link copied to clipboard
typealias LoginOrCreateUserByEmailResponse = StytchResult<BasicData>

Type alias for StytchResult used for loginOrCreateUserByEmail responses

Link copied to clipboard
interface MagicLinks

MagicLinks interface that encompasses authentication functions as well as other related functionality

Link copied to clipboard
interface OTP

OTP interface that encompasses authentication functions as well as other related functionality

Link copied to clipboard
interface Passwords

Passwords interface that encompasses authentication functions as well as other related functionality

Link copied to clipboard
typealias PasswordsCreateResponse = StytchResult<CreateResponse>

Type alias for StytchResult used for PasswordsCreate responses

Link copied to clipboard
typealias PasswordsStrengthCheckResponse = StytchResult<StrengthCheckResponse>

Type alias for StytchResult used for PasswordsStrengthCheck responses

Link copied to clipboard
interface Sessions

Sessions interface that encompasses authentication functions as well as other related functionality

Link copied to clipboard
object StytchClient

The entrypoint for all Stytch-related interaction.

Link copied to clipboard
sealed class StytchExceptions : Exception

Exception wrapper meant for use with Stytch-specific exceptions and provides a straightforward way to encompass any possible errors that come from the SDK.

Link copied to clipboard
sealed class StytchResult<out T>

Provides a wrapper for responses from Stytch API responses

Link copied to clipboard
interface UserManagement
Link copied to clipboard
typealias UserResponse = StytchResult<UserData>

Type alias for StytchResult used for GetUser responses

Functions

Link copied to clipboard
fun String.toStytchErrorType(): StytchErrorType?

Converts a string to an error type supported by Stytch